[]
添加新的导出模板。
请求数据格式
返回值
状态码: 200
成功
状态码: 400
错误的请求
状态码: 403
禁止
获取导出模板列表。
返回值
状态码: 200
成功
ExportTemplateSettingsResponse
状态码: 403
禁止
更新导出模板。
参数:
名称 | 类型 | 位置 | 描述 |
---|---|---|---|
exportTemplateId必填项 | string | path | 导出模板 ID。例如:eb6d614f-e595-4de6-8c51-c54c6b07c295 |
请求数据格式
返回值
状态码: 204
无内容
状态码: 400
错误的请求
状态码: 403
禁止
删除导出模板。
参数:
名称 | 类型 | 位置 | 描述 |
---|---|---|---|
exportTemplateId必填项 | string | path | 导出模板 ID。例如:eb6d614f-e595-4de6-8c51-c54c6b07c295 |
返回值
状态码: 200
成功
状态码: 400
错误的请求
状态码: 403
禁止
获取导出模板的计数。
返回值
状态码: 200
成功
状态码: 403
禁止
获取按目标位置列出的导出模板设置列表。
参数:
名称 | 类型 | 位置 | 描述 |
---|---|---|---|
targetPlaces必填项 | string | path | 可接受的值:API、调度程序、查看器、门户、全部及其组合,以逗号分隔。 |
返回值
状态码: 200
成功
ExportTemplateSettingsResponse
状态码: 400
错误的请求
状态码: 403
禁止
添加导出模板响应模型。
名称 | 类型 | 描述 | 示例 |
---|---|---|---|
id可为空 | string | 导出模板 ID。 |
报表插件错误
名称 | 类型 | 描述 | 示例 |
---|---|---|---|
code可为空 | string | 错误代码 | |
message可为空 | string | 错误信息 | |
context可为空 | string | 错误上下文 |
导出模板设置请求模型。
名称 | 类型 | 描述 | 示例 |
---|---|---|---|
description | string | 导出模板的描述。 | |
exportType | ExportType | ||
name | string | 导出模板的名称。 | |
roles | Array<string> |
导出模板可用的角色。 | ["Everyone"] |
targetPlaces | TargetPlaces | ||
exportSettings | any | 导出设置。 | {"Version":"Pdf14","Title":"Example title"} |
allowedSettings | Boolean | 允许的设置。 | {"Version":true,"Author":true} |
index | int32 | 排序索引。 | 1 |
icon | ExportTemplateIcon |
Enum:
Pdf
Excel
Exceldata
Docx
Csv
Html
Image
Json
Txt
Xml
导出类型
* pdf
- 0 - PDF
* excel
- 1 - Excel
* exceldata
- 2 - Excel 数据
* docx
- 3 - Word
* csv
- 4 - CSV
* html
- 5 - HTML
* image
- 6 - 图像
* json
- 7 - Json
* txt
- 8 - Txt
* xml
- 9 - XML
Enum:
None
API
Scheduler
Viewer
Portal
All
枚举模板可用的位置。
* none
- 0 - 无
* api
- 1 - API
* scheduler
- 2 - 调度程序\ r
* viewer
- 4 - 查看者
* portal
- 8 - 门户
* all
- 15 - 全部
导出模板图标模型。
名称 | 类型 | 描述 | 示例 |
---|---|---|---|
type可为空 | string | 导出模板图标类型。 | |
name可为空 | string | 导出模板图标名称。 | |
color可为空 | string | 导出模板图标颜色。 | |
value可为空 | string | 导出模板自定义图标值。 |
导出模板设置响应模型。
名称 | 类型 | 描述 | 示例 |
---|---|---|---|
id可为空 | string | 导出模板 ID。 | |
description可为空 | string | 导出模板的描述。 | |
exportType可为空 | string | 导出模板的导出类型。 | |
name可为空 | string | 导出模板的名称。 | |
roles可为空 | Array<string> |
导出模板可用的角色。 | |
targetPlaces | TargetPlaces | ||
exportSettings可为空 | any | 导出设置。 | |
allowedSettings可为空 | Boolean | 允许的设置。 | |
index | int32 | 排序索引。 | |
icon | ExportTemplateIcon |
导出模板响应模型的计数。
名称 | 类型 | 描述 | 示例 |
---|---|---|---|
count | int32 | 导出模板的计数。 |